/*
 * Copyright 2006-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.martinimix.beans.bind;

import java.util.Map;

/**
 * Provides a field to property name mapper.
 * 
 * @author Scott Rossillo
 *
 */
public interface FieldPropertyMappingHandler {

	/**
	 * Returns a map containing the field names of the bean as keys
	 * mapping to the to business object properties names to which 
	 * values can be assigned.
	 * 
	 * @param bean the <code>Object</code> whose field to property mappings
	 * should be returned
	 * 
	 * @return a <code>Map</code> containing the name of the given 
	 * <code>bean</code>'s fields as keys mapping to the business object
	 * properties to which they can be assigned
	 */
	public Map mapFieldsToProperties(Object bean);
	
	/**
	 * Returns a map containing the business object property names
	 * as keys mapping to the field names on the given bean to
	 * which values can be assigned.
	 * 
	 * @param bean the <code>Object</code> whose property to field mappings
	 * should be returned
	 * 
	 * @return a <code>Map</code> containing the business object property
	 * names as keys mapping to the <code>bean</code> field names to
	 * which values can be assigned.
	 */
	public Map mapPropertiesToFields(Object bean);

}